Pia: Staff Offboarding Package
Overview
The Staff Offboarding package configuration form can be found within the clients screen.
This document details how to navigate to the configuration form, and what all the available fields mean. Where there is a difference in configuration between environments, this will be indicated.
Configuration Form
The Form Fields in the New Staff configuration form may slightly vary depending on which environment it is supporting. There are four Staff Offboarding packages available in Pia depending on four environments:
- Cloud Only
- Cloud Hybrid
- On Prem
- Semi-Hybrid
Each package has its own configuration form which has been defined below.
- Cloud Only
- Cloud Hybrid
- On Prem
- Semi-Hybrid
Cloud Properties
| Field Name | Default Value | Details |
|---|---|---|
| UPN of Admin Account (Graph API Delegated Consent) | =global.adminUpn | UPN of the Primary Account with Microsoft Graph consent to Offboard Staff. |
| All staff group (optional) | =global.allStaffGroup | All Staff Group that the package will refer to retrieve a list of active users for the client |
| Extra AD Attribute Settings | - | (One per line) Format: name|value |
| Remove Group Exclusions | - | (One per line) Groups to exclude from Removal when Staff Offboarding |
License De-Provisioning
Note
These options are only valid when there is a Licensing CSP Integration Configured for the client.
| Field Name | Details |
|---|---|
| Enable License de-provisioning | Allows de-provisioning of the license when they are offboarded |
| Prompt for confirmation before de-provisioning | Displays a prompt before license de-provisioning to verify action |
| Allow de-provisioning licenses with Annual commitments | Enables de-provisioning of licenses with Annual commitments and have not expired yet |
Extra Features
| Field Name | Details |
|---|---|
| Disable Contact Modification in Ticketing System | If checked, the staff contact will not be modified upon staff offboarding |
Pre-Termination Manual Tasks
- Additional Tasks can be added by clicking the 'Insert +' link.
- Remove unneeded Tasks by clicking the 'Delete-' link.
| Field Name | Details |
|---|---|
| Pre-Termination Manual Tasks | Detail manual tasks that will be displayed in the chatbot for the Service Desk Engineer to complete before the package starts executing |
Manual Tasks
- Additional Tasks can be added by clicking the 'Insert +' link.
- Remove unneeded Tasks by clicking the 'Delete-' link.
| Field Name | Details |
|---|---|
| Task | Detail manual tasks that will be added to the ticket for the Service Desk Engineer to complete |
Hybrid Properties
| Field Name | Default Value | Details |
|---|---|---|
| All staff group (optional) | =global.allStaffGroup | All Staff Group that the package will refer to retrieve a list of active users for the client |
| Primary Domain Controller | =global.primaryDC | Name of the Primary Domain Controller for the client |
| Azure AD Connect Server | =global.azureADConnectServer | Name of the server that facilitates synchronizing user details from an on-prem AD to Azure AD for the client |
| Exchange Server (optional) | =global.exchange_server | Name of the Exchange Server for the client |
| Preferred Disable User's OU (optional) | - | The preferred Org Unit where the user will be moved to after offboarding |
| UPN of Admin Account (Graph API Delegated Consent) | =global.adminUpn | UPN of the Primary Account with Microsoft Graph consent to offboard a user. |
| Extra AD Attribute Settings | - | (One per line) Format: name|value |
| Remove Group Exclusions | - | (One per line) Groups to exclude from Removal when Staff Offboarding |
Extra Features
| Allow setting of user's description in Active Directory | - | Enables a form field to setup additional information for the user in the Chatbot during package execution |
| Disable Contact Modification in Ticketing System | If checked, the staff contact will not be modified upon staff offboarding |
License De-Provisioning
info
These options are only valid when there is a Licensing connected service configured for the client.
| Field Name | Details |
|---|---|
| Enable License de-provisioning | Allows de-provisioning of the license when they are offboarded |
| Prompt for confirmation before de-provisioning | Displays a prompt before license de-provisioning to verify action |
| Allow de-provisioning licenses with Annual commitments | Enables de-provisioning of licenses with Annual commitments and have not expired yet |
Pre-Offboarding Manual Tasks
- Additional Tasks can be added by clicking the 'Insert +' link.
- Remove unneeded Tasks by clicking the 'Delete-' link.
| Field Name | Details |
|---|---|
| Pre-Termination Manual Tasks | Detail manual tasks that will be displayed in the chatbot for the Service Desk Engineer to complete before the package starts executing |
Manual Tasks
- Additional Tasks can be added by clicking the 'Insert +' link.
- Remove unneeded Tasks by clicking the 'Delete-' link.
| Field Name | Details |
|---|---|
| Task | Detail manual tasks that will be added to the ticket for the Service Desk Engineer to complete |
Active Directory Properties
| Field Name | Default Value | Details |
|---|---|---|
| All staff group (optional) | =global.allStaffGroup | All Staff Group that the package will refer to retrieve a list of active users for the client |
| Primary Domain Controller | =global.primaryDC | Name of the Primary Domain Controller for the client |
| Preferred Disable User's OU (optional) | - | The preferred Org Unit where the user will be moved to after termination |
| Extra AD Attribute Settings | - | (One per line) Format: name|value |
| Remove Group Exclusions | - | (One per line) Groups to exclude from Removal when Staff offboarding |
Extra Features
| Allow setting of user's description in Active Directory | - | Enables a form field to setup additional information for the user in the Chatbot during package execution |
| Disable Contact Modification in Ticketing System | If checked, the user contact will not be modified upon user termination |
Pre-Termination Manual Tasks
- Additional Tasks can be added by clicking the 'Insert +' link.
- Remove unneeded Tasks by clicking the 'Delete-' link.
| Field Name | Details |
|---|---|
| Pre-Termination Manual Tasks | Detail manual tasks that will be displayed in the chatbot for the Service Desk Engineer to complete before the package starts executing |
Manual Tasks
- Additional Tasks can be added by clicking the 'Insert +' link.
- Remove unneeded Tasks by clicking the 'Delete-' link.
| Field Name | Details |
|---|---|
| Task | Detail manual tasks that will be added to the ticket for the Service Desk Engineer to complete |
Semi-Hybrid Properties
| Field Name | Default Value | Details |
|---|---|---|
| Primary Domain Controller | =global.primaryDC | Name of the Primary Domain Controller for the client |
| Azure AD Connect Server | =global.azureADConnectServer | Name of the server that facilitates synchronizing user details from an on-prem AD to Azure AD for the client |
| Exchange Server | =global.exchange_server | Name of the Exchange Server for the client |
Azure Properties
| Field Name | Default Value | Details |
|---|---|---|
| All staff group (optional) | =global.azure_all_staff_group | All Staff Group that the package will refer to retrieve a list of active users for the client |
| Extra AD Attribute Settings | - | (One per line) Format: name|value |
| Remove Group Exclusions | - | (One per line) Groups to exclude from Removal when staff offboarding |
Active Directory Properties
| Field Name | Default Value | Details |
|---|---|---|
| All staff group (optional) | =global.allStaffGroup | All Staff Group that the package will refer to retrieve a list of active users for the client |
| Preferred Disable User's OU (optional) | - | The preferred Org Unit where the user will be moved to after termination |
| Extra AD Attribute Settings | - | (One per line) Format: name|value |
| Remove Group Exclusions | - | (One per line) Groups to exclude from Removal when Staff offboarding |
| Allow setting of user's description in Active Directory | - | Enables a form field to setup additional information for the user in the Chatbot during package execution |
Extra Features
| Allow setting of user's description in Active Directory | - | Enables a form field to setup additional information for the user in the Chatbot during package execution |
| Disable Contact Modification in Ticketing System | If checked, the user contact will not be modified upon user termination |
License De-Provisioning
info
These options are only valid when there is a Licensing connected service configured for the client.
| Field Name | Details |
|---|---|
| Enable License de-provisioning | Allows de-provisioning of the user license when they are terminated |
| Prompt for confirmation before de-provisioning | Displays a prompt before license de-provisioning to verify action |
| Allow de-provisioning licenses with Annual commitments | Enables de-provisioning of licenses with Annual commitments and have not expired yet |
Pre-Termination Manual Tasks
- Additional Tasks can be added by clicking the 'Insert +' link.
- Remove unneeded Tasks by clicking the 'Delete-' link.
| Field Name | Details |
|---|---|
| Pre-Termination Manual Tasks | Detail manual tasks that will be displayed in the chatbot for the Service Desk Engineer to complete before the package starts executing |
Manual Tasks
- Additional Tasks can be added by clicking the 'Insert +' link.
- Remove unneeded Tasks by clicking the 'Delete-' link.
| Field Name | Details |
|---|---|
| Task | Detail manual tasks that will be added to the ticket for the Service Desk Engineer to complete |